/*
 * TMEventUpdate.java
 * www.bouthier.net
 *
 * The MIT License :
 * -----------------
 * Copyright (c) 2001 Christophe Bouthier
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
 
package geovista.treemap.tm;

 
/**
 * The TMEventUpdate abstract class implements a update event 
 * send by a TMUpdaterConcrete to a TMNodeModelRoot.
 * Such an event is send when something has changed in
 * a TMNode. This TMNode is then encapsulated in the event.
 * The TMEventUpdate implements the command design pattern.
 * The TMEventUpdate should be subclassed to indicate the
 * type of event to send.
 *
 * @author Christophe Bouthier [bouthier@loria.fr]
 * 
 */
abstract class TMEventUpdate {

    private TMNode node = null; // the node encapsulated
    
    
  /* --- Constructor --- */
  
    /**
     * Constructor.
     *
     * @param node    the TMNode to encapsulate
     */
    protected TMEventUpdate(TMNode node) {
        this.node = node;
    }
    
    
  /* --- Accessor --- */
  
    /**
     * Returns the TMNode to redraw.
     *
     * @return    the node to redraw
     */
    TMNode getNode() {
        return node;
     }
     
  
  /* --- Command design pattern --- */

    /**
     * Executed on the TMView when received.
     * Should be implemented by subclass to
     * update correctly the TMView.
     */
    abstract void execute(TMNodeModelRoot model);
    
}

